filter-obj

filter-obj

Filter object keys and values into a new object

Install

npm install filter-obj

Usage

import {includeKeys, excludeKeys} from 'filter-obj';

const object = {
	foo: true,
	bar: false
};

const newObject = includeKeys(object, (key, value) => value === true);
//=> {foo: true}

const newObject2 = includeKeys(object, ['bar']);
//=> {bar: false}

const newObject = excludeKeys(object, (key, value) => value === true);
//=> {bar: false}

const newObject3 = excludeKeys(object, ['bar']);
//=> {foo: true}

API

includeKeys(source, filter)

includeKeys(source, keys)

excludeKeys(source, filter)

excludeKeys(source, keys)

source

Type: object

The source object to filter properties from.

filter

Type: (sourceKey: string | symbol, sourceValue: unknown, source: object) => boolean

A predicate function that determines whether a property should be filtered.

keys

Type: Array<string | symbol> | Set<string | symbol>

An array or Set of property keys to be filtered.

Related

• map-obj - Map object keys and values into a new object

Similar packages

Other packages similar to filter-obj

lodash.pick

lodash.pick is a method from the Lodash library that creates an object composed of the picked object properties. It is similar to filter-obj but is part of a larger utility library, which might be preferable for users who need other utility functions.

object-filter

object-filter is another npm package that provides similar functionality to filter-obj, allowing filtering of object properties based on a predicate function. It compares to filter-obj in terms of functionality but might have different implementation details or additional options.